Serving WebObjects

PATH WebObjects 4.0 Documentation > Serving WebObjects

Starting Up Applications From the Command Line

The syntax for starting a WebObjects application from a command shell window is:

AppExecutable [ -WODebuggingEnabled YES|NO][ -WOAutoOpenInBrowser YES|NO]
[ -WOMonitorEnabled YES|NO [ -WOMonitorHost hostname|subnet]][ -WOCachingEnabled YES|NO]
[[ -WOAdaptor adaptorClass] [ -WOPort portNumber]
[ -WOListenQueueSize listenQueueSize]]
[ -WOWorkerThreadCount int] [-WOOtherAdaptors plist]
[ -WOCGIAdaptorURL path] [ -WOApplicationBaseURL path]
[ -WOFrameworksBaseURL path] [ -NSProjectSearchPath plist]
[ -WOIncludeCommentsInResponses YES|NO] [-WOSessionTimeout seconds]

The AppExecutable variable represents the name of the WebObjects application executable to run. You should enter the command from the directory containing the executable. Compiled applications should either be located in NEXT_ROOT/Library/WOApps (recommended) or under <DocRoot>/WebObjects. For scripted applications, go to the application's .woa directory and execute WODefaultApp, which is located in NEXT_ROOT/Library/Executables.

The following table describes each command-line option:

Option Description

-WODebuggingEnabled
YES|NO Sets whether the application prints messages to standard error during startup. By default, this option is enabled. WOApplication, WOComponent, and WOSession define a new debugWithFormat: method (debugString in Java). This method is similar to logWithFormat: except that it only prints messages if the WODebuggingEnabled option is on

-WOAutoOpenInBrowser
YES|NO Sets whether the application automatically opens a web browser window to the application's URL (starting up the browser if necessary). By default, this option is enabled.

-WOMonitorEnabled
YES|NO Enables or disables monitoring. By default, this option is disabled. If this option is enabled and you manually start an application, the application tries to find a running WOMonitor.

-WOMonitorHost
hostName | subnet If the WOMonitorEnabled option is on and you use this option, the application tries to find a running WOMonitor on the machine named hostName instead of on the local machine. If subnet is used, the application looks for a running WOMonitor in its network subnet.

-WOCachingEnabled
YES|NO Requests that the application cache component definitions (templates) instead of reparsing HTML and declaration files upon each new HTTP request. By default, this option is disabled.

-WOAdaptor adaptorClass The WOAdaptor class name. The default is now WOMultiThreadedAdaptor.

-WOPort portNumber The socket port used to connect to an application instance. Unlike previous versions of WebObjects, this option is independent of the adaptor option. A portNumber of -1 means use an arbitrary high port number; however, you cannot specify -1 as the value on the command line; to set the value to -1, you must use the defaults command.

-WOListenQueueSize listenQueueSize The depth of the listen queue. The default is now 5, meaning that while the application process is handling a request, up to five other requests can be in the socket buffer before the socket starts refusing them. If the application is expected to experience "spikes" in its processing load, it might be a good idea to increase the listen queue depth. Increasing this default does not necessarily improve performance or allow the application to serve more requests at sustained high loads. For more information, see "Increasing the Listen Queue Depth" in this guide.

-WOWorkerThreadCount int Maximum number of worker threads for a multithreaded application. The default worker thread count is 8. Setting this count to 0 results in single-threaded (WebObjects 3.5-style) request dispatch.

-WOOtherAdaptors plist Use this option to attach additional adaptors (other than the one specified by -WOAdaptor) to the application. The plist option is an array of dictionaries written in property-list format.

-WOCGIAdaptorURL
path The absolute URL that points to the WebObjects CGI adaptor.

-WOApplicationBaseURL
aURL The URL where your application's resources are located under the web server's document root. You may place your application anywhere under the document root. This option is required when you're using a web server. If you install the application in a subdirectory of <DocRoot>/WebObjects, you should set this to point to the exact location of the application directory. If you don't set the application's base URL, your application can still run but it cannot find image files and other web server resources.

-WOFrameworksBaseURL
aURL The location of frameworks under your document root if you're using a web server. The default is /WebObjects/Frameworks (as it was in release 3.5). All frameworks that your application uses must be in this directory.

-NSProjectSearchPath
pList An array of paths in which your project directories are located. (The array is written in property-list format.) The default is a single item: ".." If you specify this option, WebObjects looks in the locations you specify for a project that has the same name as the application or framework being loaded. If it finds a project, it uses the images, scripted components, and other resources from the project directory instead of from the application or framework's main bundle. This way, you can modify images and scripted components in your project and test them without having to rebuild the application.

-WOIncludeComments
InResponses YES|NO Sets whether the HTML parser includes comments from the components' HTML files in the responses. The default is YES.

-WOSessionTimeout timeout Sets the timeout interval for sessions. By default, they now time out after 3600 seconds.

Option	Description
-WODebuggingEnabled YES\|NO	Sets whether the application prints messages to standard error during startup. By default, this option is enabled. WOApplication, WOComponent, and WOSession define a new debugWithFormat: method (debugString in Java). This method is similar to logWithFormat: except that it only prints messages if the WODebuggingEnabled option is on
-WOAutoOpenInBrowser YES\|NO	Sets whether the application automatically opens a web browser window to the application's URL (starting up the browser if necessary). By default, this option is enabled.
-WOMonitorEnabled YES\|NO	Enables or disables monitoring. By default, this option is disabled. If this option is enabled and you manually start an application, the application tries to find a running WOMonitor.
-WOMonitorHost hostName \| subnet	If the WOMonitorEnabled option is on and you use this option, the application tries to find a running WOMonitor on the machine named hostName instead of on the local machine. If subnet is used, the application looks for a running WOMonitor in its network subnet.
-WOCachingEnabled YES\|NO	Requests that the application cache component definitions (templates) instead of reparsing HTML and declaration files upon each new HTTP request. By default, this option is disabled.
-WOAdaptor adaptorClass	The WOAdaptor class name. The default is now WOMultiThreadedAdaptor.
-WOPort portNumber	The socket port used to connect to an application instance. Unlike previous versions of WebObjects, this option is independent of the adaptor option. A portNumber of -1 means use an arbitrary high port number; however, you cannot specify -1 as the value on the command line; to set the value to -1, you must use the defaults command.
-WOListenQueueSize listenQueueSize	The depth of the listen queue. The default is now 5, meaning that while the application process is handling a request, up to five other requests can be in the socket buffer before the socket starts refusing them. If the application is expected to experience "spikes" in its processing load, it might be a good idea to increase the listen queue depth. Increasing this default does not necessarily improve performance or allow the application to serve more requests at sustained high loads. For more information, see "Increasing the Listen Queue Depth" in this guide.
-WOWorkerThreadCount int	Maximum number of worker threads for a multithreaded application. The default worker thread count is 8. Setting this count to 0 results in single-threaded (WebObjects 3.5-style) request dispatch.
-WOOtherAdaptors plist	Use this option to attach additional adaptors (other than the one specified by -WOAdaptor) to the application. The plist option is an array of dictionaries written in property-list format.
-WOCGIAdaptorURL path	The absolute URL that points to the WebObjects CGI adaptor.
-WOApplicationBaseURL aURL	The URL where your application's resources are located under the web server's document root. You may place your application anywhere under the document root. This option is required when you're using a web server. If you install the application in a subdirectory of <DocRoot>/WebObjects, you should set this to point to the exact location of the application directory. If you don't set the application's base URL, your application can still run but it cannot find image files and other web server resources.
-WOFrameworksBaseURL aURL	The location of frameworks under your document root if you're using a web server. The default is /WebObjects/Frameworks (as it was in release 3.5). All frameworks that your application uses must be in this directory.
-NSProjectSearchPath pList	An array of paths in which your project directories are located. (The array is written in property-list format.) The default is a single item: ".." If you specify this option, WebObjects looks in the locations you specify for a project that has the same name as the application or framework being loaded. If it finds a project, it uses the images, scripted components, and other resources from the project directory instead of from the application or framework's main bundle. This way, you can modify images and scripted components in your project and test them without having to rebuild the application.
-WOIncludeComments InResponses YES\|NO	Sets whether the HTML parser includes comments from the components' HTML files in the responses. The default is YES.
-WOSessionTimeout timeout	Sets the timeout interval for sessions. By default, they now time out after 3600 seconds.

You can also set these options programmatically or by using the defaults utility. Be careful when setting options programmatically. Most options require knowledge of the environment in which the application runs, and the appropriate values change if you move the application to a different machine. For example, you should never set the WOPort option programmatically.

Notes

The web server uses the <DocRoot> and ApplicationName arguments to build URLs, so you should use forward slashes as opposed to a backslashes when specifying these arguments.

As a convenience, you might create a shell script that starts WebObjects applications when the server machine is booted. You also might create another shell script that you can run at the command line to start applications.

Table of Contents Next Section